Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Various Enhancements #179

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Conversation

martinklepsch
Copy link
Contributor

@martinklepsch martinklepsch commented Nov 12, 2018

Hey @weavejester, I've forked Codox for https://cljdoc.org for a while running on some commits that may also be interesting for mainline Codox. This PR includes a lot of unnecessary commits but I will describe the few relevant ones below and you can cherry pick whatever you like. I can also create a new PR with the ones you're interested in.

Feel free to close this PR after seeing it, it's not really intended to be merged as-is but more of a heads up and an offer to contribute some of the changes below back to Codox.

Trust cljs analyser to read macros correctly

Codox previously did two passes to also read macros for ClojureScript. This is actually no longer necessary with more recent versions of ClojureScript.

cljdoc@3079986

Remove 'quote from arglists

For some reason the list? check wasn't enough to remove 'quote and I ended up with 'quote in arglists. seq? did the trick (and might be more appropriate anyways?).

cljdoc@25b01ae

Better handle namespaces defined by multiple files

When there are multiple files (e.g. .clj and .cljc) for a namespace Codox would analyse those namespaces twice returning the analysis result twice as well. (See cljdoc/cljdoc#155.)

cljdoc@3f2ea84

Better support ClojureScript 1.10.439

I noticed some issues (+ more details) with the new CLJS version. Turns out setting *analyze-deps* to false was never really supported for macro-containing namespaces and we just got lucky.

cljdoc@e0cd269

Thanks

Thanks for your excellent work on Codox, it really helped with cljdoc and has been an inspiration in many regards 🙌 If you want I'd be happy to send you some stickers as well, just send me your address via email 🙂

@weavejester
Copy link
Owner

Thanks for telling me about these changes. I'll take a closer look at them later this week, but they all look like useful additions that can be merged back into Codox, so thank you for your work on this!

@n2o
Copy link

n2o commented Feb 15, 2019

I'd love to see this included into the codox project 👍

roosta added a commit to roosta/herb that referenced this pull request Jul 17, 2019
Switch to cljdoc, issues where macros ns and cljs ns would generate
duplicate doc entries. See:

weavejester/codox#179
cljdoc/cljdoc#155
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants